fix: Fix type definitions for cy.reload() #25779

podlesny-j · 2023-02-12T22:07:52Z

https://docs.cypress.io/api/commands/reload
cy.reload()
cy.reload(forceReload)
cy.reload(options)
cy.reload(forceReload, options)

Closes - could not find any open issues for this

Additional details

currently the last option - passing two arguments to cy.reload() command - is not supported in type definition for this command and results in typescript error

Steps to test

All 4 possible argument use-cases for this command have been teste locally by me and work correctly TypeScript-wise.
Screenshots provided in next section ( ### How has the user experience changed? )

How has the user experience changed?

PR Tasks

N/A Have tests been added/updated?
N/A Has the original issue (or this PR, if no issue exists) been tagged with a release in ZenHub? (user-facing changes only)
N/A Has a PR for user-facing changes been opened in cypress-documentation?
Have API changes been updated in the type definitions?

CLAassistant · 2023-02-12T22:07:58Z

All committers have signed the CLA.

podlesny-j · 2023-02-12T22:57:56Z

Hey, just two things:

This is my first PR so sorry if I missed anything 🙃
I'm new to TypeScript so I hope the code's ok 🤞

EDIT: It seems it's not (obviously 🥵). Going to work on a fix...
EDIT2: hopefully fixed

Thanks for taking the time to review this!

cypress · 2023-02-12T23:30:36Z

40 flaky tests on run #44066 ↗︎

0	26802	1271	0	40

Details:

review requests
Project: cypress	Commit: `88d61a90be`
Status: Passed	Duration: 19:47 💡
Started: Feb 14, 2023 1:59 PM	Ended: Feb 14, 2023 2:19 PM

e2e/origin/cookie_behavior.cy.ts • 4 flaky tests • 5x-driver-electron

View Output Video

Test
... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
... > same site / cross origin > fetch > sets same-site cookies if "include" credentials option is specified from request, but does not attach same-site cookies to request by default (same-origin)
... > same site / cross origin > XMLHttpRequest > sets cookie on same-site request if withCredentials is true, and attaches to same-site request if withCredentials is true
... > same site / cross origin > fetch > sets same-site cookies if "include" credentials option is specified from request, but does not attach same-site cookies to request by default (same-origin)

cypress/cypress.cy.js • 3 flaky tests • 5x-driver-electron

View Output Video

Test
... > correctly returns currentRetry
... > correctly returns currentRetry
... > correctly returns currentRetry

create-from-component.cy.ts • 2 flaky tests • app-e2e

View Output Video

Test
... > runs generated spec		`Screenshot`
... > runs generated spec		`Screenshot`

specs_list_latest_runs.cy.ts • 1 flaky test • app-e2e

View Output Video

Test
App/Cloud Integration - Latest runs and Average duration > when no runs are recorded > shows placeholders for all visible specs		`Screenshot`

cypress-origin-communicator.cy.ts • 1 flaky test • app-e2e

View Output Video

Test
Cypress In Cypress Origin Communicator > cy.origin passivity with app interactions > passes upon test reload mid test execution		`Screenshot`

The first 5 flaky specs are shown, see all 17 specs in Cypress Cloud.

_{This comment has been generated by cypress-bot as a result of this
project's GitHub integration settings.}

warrensplayer

A few suggestions

cli/types/cypress.d.ts

warrensplayer · 2023-02-13T23:40:27Z

@podlesny-j Thanks so much for the contribution. I added a few requests to the PR.

cy.reload() cy.reload(forceReload) cy.reload(options) cy.reload(forceReload, options)

warrensplayer

Changes look good

warrensplayer

The changes look good, but this did not get approved in time to make the release today. Please update the CHANGELOG.md to put your change in for version 12.7.0 to be released on 02/28/2023. Then this PR can get merged tomorrow after the release gets created today.

Our release has been delayed, so if you get the Changelog suggestions in that were suggested below, then it can go ahead and get merged.

cli/CHANGELOG.md

emilyrohrbough

Changelog entry needs updated

podlesny-j · 2023-02-15T14:50:34Z

The changes look good, but this did not get approved in time to make the release today. Please update the CHANGELOG.md to put your change in for version 12.7.0 to be released on 02/28/2023. Then this PR can get merged tomorrow after the release gets created today.

Our release has been delayed, so if you get the Changelog suggestions in that were suggested below, then it can go ahead and get merged.

I guess I did not make it in time, the Semantic lint is now failing due to the release date already being set in the changelog file in develop branch... 😞

Changelog updates have been made.

* fix: update newProject ref when switching between organizations in SelectCloudProjectModal (#25730) * chore: debug page tooltip distance and artifact border (#25727) * misc: debug page tooltip distance and artifact border * add changelog entry * fix CT test * fix: Improve error handling around calls to `this.next` in middleware (#25702) * chore: update changelog validation example (#25742) * misc: improve debug loading text wrap responsiveness (#25703) * misc: Increase max failures in IATR badge to 99 (#25737) * chore: exclude collaborator issues/PRs from triage project (#25769) * feat: add --auto-cancel-after-failures flag (#25237) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Ryan Pei <ryanppei@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@yahoo.com> * chore: Update v8 snapshot cache (#25592) * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * Update update_v8_snapshot_cache.yml * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache * chore: updating v8 snapshot cache --------- Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> Co-authored-by: cypress-bot[bot] <47117332+cypress-bot[bot]@users.noreply.github.com> * fix: implement new graphql fields for spec counts (#25757) Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> * feat: Bundle cy.origin() dependencies at runtime (#25626) Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> * chore: remove zenhub from release process (#25701) Co-authored-by: Matt Schile <mschile@cypress.io> * feat: add Cypress.Commands.overwriteQuery (#25674) * feat: add Cypress.Commands.overwriteQuery Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Zach Bloomquist <git@chary.us> * fix: spawn child process with process.env in macOS arm64 (#25753) Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Zach Bloomquist <github@chary.us> * chore: lint system tests in CI (#25673) * fix: Suppress filesystem errors during glob search (#25774) * chore: issue with ts-loader missing in binary and problematic esbuild norewrite construct (#25797) * chore: update changelog linting (#25809) * docs(guides): add more detail to code-signing (#25794) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: update workflows.yml to include the v8 snapshot update branch (#25784) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> * chore: internal request preflight (#25772) --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> Co-authored-by: Zach Bloomquist <git@chary.us> * chore: bump for 12.6.0 release (#25812) * chore: release @cypress/webpack-batteries-included-preprocessor-v2.4.0 [skip ci] * chore: release @cypress/webpack-preprocessor-v5.17.0 [skip ci] * test: skip flaky GitDataSource test (#25825) * chore: making our add-to-triage-board workflow reusable within the Cypress-io org (#25820) * chore: Making our add to triage workflow callable from other projects inside the Cypress-io org in Github * chore: updated cypress-example-kitchensink version (#25828) * fix: duplicate and expired cookies (#25761) * chore: add regression tests for duplicate cookies and bad expiry times * avoid prepending domain with dot for cookies that are set with the server side jar. This is to avoid the cookie being duplicated if it is set or overridden in a different context (request that can actually set the cookie or via document.domain) * feat: use cookie.toString() in the cookie patch to more accurately set cookies on the document, which should include other properties besides key=value * fix: add logic to handle expired cookies in the document.cookie patch, as well as in CDP * chore: build binary for cookie fixes for users to test * chore: change name of fixture to something more accurate * chore: comment why we are using the toughCookie toString method in the patch * [run ci] * chore: add changelog entry * [run ci] * fix: revert back to key=value when getting document.cookie as those are the only values are displayed (oversight on my end) * [run ci] * chore: make compatible with cypress.require * fix: add tests for hostOnly/non hostOnly cookies to make sure property gets sent up to automation client correctly. No longer need custom cookie prop to determine destination * [run ci] * fix: stale unit test * chore: adjust comments * [run ci] * fix: bad domain logic * [run ci] * chore: remove irrelevant comment * [run ci] * fix: adjust cookie login text to spec hostOnly cookie within the cookie patch. This should yield the same behavior as we are bound to same origin within the spec bridge * [run ci] * [run ci] * fix: allow for cookies on request of same key to take precedence over cookies in the jar, regardless of how many hierachy cookies exist in the jar * chore: fix cookie misc tests for cy.origin (dont run cy.origin) * [run ci] * chore: skip misc cookie tests in webkit as headless behavior doesn't clear cookies between tests correctly * Revert "fix: allow for cookies on request of same key to take precedence over cookies in the jar, regardless of how many hierachy cookies exist in the jar" This reverts commit 17de188. * [run ci] * chore: split changelog entry into two parts * chore: update logic to remove else statement and add comments * [run ci] * chore: readd windows snapshot branch in workflows * [run ci] * chore: fix workflows from bad merge * [run ci] * Revert "chore: split changelog entry into two parts" This reverts commit 4352ef5. * [run ci] * fix: Fix type definitions for cy.reload() (#25779) Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * misc: Debug header updates (#25823) * fix: allow running tests outside Vite project root folder (#25801) * fix: allow running tests outside Vite project root folder * update snapshots * add changelog entry --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * fix: mount component in [data-cy-root] (#25807) * fix(angular): mount component in [data-cy-root] * fix e2e test * add changelog entry * changelog [skip ci] * changelog --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * chore: updating add to triage baord github action to use org secret (#25868) * chore: updating add to triage board github action to use org secret * chore: release @cypress/angular-v2.0.2 [skip ci] * chore: release @cypress/vite-dev-server-v5.0.3 [skip ci] * chore: Update v8 snapshot cache (#25822) Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> * feat: support host only cookies (#25853) * feat: allow setCookie API to take a hostOnly option * chore: add jsdoc/typescript description to render to users * chore: add changelog entry * [run ci] * chore: fix types * chore: fix cookie login tests * chore: update e2e cookie system tests * [run ci] * chore: fix cookie command tests. localhost cookies are calculated as hostOnly, which is consistent with how cypress works today * chore: fix system tests for cookies. * [run ci] * chore: fix system tests * chore: skip hostOnly assertions in webkit (for now) * [run ci] * chore: add property definitions to setCookieOptions * [run ci] * chore: add comments to hostOnly prop in firefox when setting a cookie * fix(webpack-dev-server): touch component-index during onSpecsChange to avoid writing to app file (#25861) * testing: try disabling uTimesSync and see what happens * build binaries [run ci] * fix: touch component index file instead of browser.js * build binaries [run ci] * update test * fix test * add test for custom HTML file in config * use existing component index in webpack-dev-server unit tests --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * chore: release @cypress/webpack-dev-server-v3.2.4 [skip ci] * chore: improve types for server automation cookie client (#25836) * chore: improve types for automation cookies * [run ci] * fix: the cookie_behavior tests by syncing cookies immediately if … (#25855) * fix: fix the cookie_behavior tests by syncing cookies immediately if the application is already stable * chore: add changelog entry * [run ci] * chore: address comments from code review * feat: Public API for CT Framework Definitions (#25780) * chore: rework component onboarding in launchpad (#25713) * chore: refactoring and types * rework source of frameworks * revert rename * fix tests * fix more tests * types * update code * use same public API internally * rename interfaces * rename * work on dev server api * fix types * fix test * attempt to support getDevServerConfig * tests * add function to define framework [skip ci] * rework a lot of types * fix test * update tests and types * refactor * revert changes * lint * fix test * revert * remove * add "community" label [skip ci] * refactor * types * lint * fix bug * update function name * address feedback * improve types with Pick * refactor using type guard * correct label --------- Co-authored-by: Zachary Williams <ZachJW34@gmail.com> * chore: typing error * feat: scan for 3rd party ct plugins (#25749) * chore: refactoring and types * rework source of frameworks * revert rename * fix tests * fix more tests * types * update code * use same public API internally * rename interfaces * rename * work on dev server api * fix types * fix test * attempt to support getDevServerConfig * tests * add function to define framework [skip ci] * rework a lot of types * fix test * update tests and types * refactor * revert changes * lint * fix test * revert * remove * add "community" label [skip ci] * refactor * types * lint * fix bug * update function name * address feedback * feat: scan for 3rd party ct plugins * add e2e test * unit tests [run ci] * tweak resolution * rebase, address comments * fix windows paths * remove .gitignore * fix test --------- Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com> * lint config * spacing * try fix race cond * fix import error * build binary * try update snapshot * try using require * support namespaced definitions (#25804) * remove category * add icon prop * support esm -> cjs compiled typescript * fix test * misc: add CTA footer to launchpad framework dropdown (#25831) * remove test project dependencies * rebase * windows * windows again * add changelog entry * changelog * revert workflow * remove worklfow --------- Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Adam Stone-Lord <adams@cypress.io> * chore: release @cypress/webpack-dev-server-v3.3.0 [skip ci] * fix: Add missing error message when `req.continue` is used incorrectly (#25884) --------- Co-authored-by: Adam Stone-Lord <adams@cypress.io> Co-authored-by: Zachary Williams <ZachJW34@gmail.com> Co-authored-by: Mike Plummer <mike-plummer@users.noreply.github.com> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Alejandro Estrada <estrada9166@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Ryan Pei <ryanppei@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@yahoo.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cypress-bot[bot] <2f0651858c6e38e0+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Ryan Manuel <ryanm@cypress.io> Co-authored-by: cypress-bot[bot] <47117332+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Mark Noonan <mark@cypress.io> Co-authored-by: Stokes Player <stokes@cypress.io> Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Zach Bloomquist <git@chary.us> Co-authored-by: willmsC <50909991+willmsC@users.noreply.github.com> Co-authored-by: Zach Bloomquist <github@chary.us> Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com> Co-authored-by: Tim Griesser <tgriesser10@gmail.com> Co-authored-by: Matt Henkes <mjhenkes@gmail.com> Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net> Co-authored-by: Ben M <benm@cypress.io> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Podles <78863563+podlesny-j@users.noreply.github.com> Co-authored-by: Paolo Caleffi <p.caleffi@dreamonkey.com> Co-authored-by: Lachlan Miller <lachlan.miller.1990@outlook.com>

podlesny-j changed the title ~~Fix type definitions for cy.reload()~~ misc Fix type definitions for cy.reload() Feb 12, 2023

podlesny-j changed the title ~~misc Fix type definitions for cy.reload()~~ misc: Fix type definitions for cy.reload() Feb 12, 2023

podlesny-j marked this pull request as ready for review February 12, 2023 22:59

podlesny-j marked this pull request as draft February 12, 2023 23:17

podlesny-j marked this pull request as ready for review February 13, 2023 10:06

nagash77 assigned warrensplayer Feb 13, 2023

warrensplayer requested changes Feb 13, 2023

View reviewed changes

cli/types/cypress.d.ts Show resolved Hide resolved

cli/types/cypress.d.ts Outdated Show resolved Hide resolved

podlesny-j and others added 9 commits February 14, 2023 11:41

Fix type definitions for cy.reload()

baf343b

cy.reload() cy.reload(forceReload) cy.reload(options) cy.reload(forceReload, options)

fix types for all argument options

8fdfb6e

fix formatting typo

cd26562

improve description

55eb108

add changelog entry

e5d725c

fix ReloadOptions interface

16c5f79

remove useless interface definition

bab7c7d

remove forgotten param of previously removed type

3fbfc75

review requests

88d61a9

podlesny-j requested a review from warrensplayer February 14, 2023 10:44

BlueWinds approved these changes Feb 14, 2023

View reviewed changes

warrensplayer approved these changes Feb 14, 2023

View reviewed changes

emilyrohrbough changed the title ~~misc: Fix type definitions for cy.reload()~~ fix: Fix type definitions for cy.reload() Feb 14, 2023

warrensplayer previously requested changes Feb 14, 2023

View reviewed changes

warrensplayer assigned marktnoonan and unassigned warrensplayer Feb 14, 2023

emilyrohrbough reviewed Feb 14, 2023

View reviewed changes

cli/CHANGELOG.md Outdated Show resolved Hide resolved

emilyrohrbough requested changes Feb 14, 2023

View reviewed changes

fix changelog entry

5a1bb4e

Merge branch 'develop' into patch-1

146376a

emilyrohrbough added 2 commits February 16, 2023 09:58

Merge branch 'develop' into patch-1

c1fdcc8

Update CHANGELOG.md

7db5c5c

emilyrohrbough approved these changes Feb 16, 2023

View reviewed changes

emilyrohrbough requested a review from warrensplayer February 16, 2023 16:03

emilyrohrbough added 2 commits February 16, 2023 11:11

Update get-binary-release-data.js

d11635d

Update get-binary-release-data.js

2aef489

emilyrohrbough merged commit 5fb2167 into cypress-io:develop Feb 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fix type definitions for cy.reload() #25779

fix: Fix type definitions for cy.reload() #25779

podlesny-j commented Feb 12, 2023 •

edited

Loading

CLAassistant commented Feb 12, 2023 •

edited

Loading

podlesny-j commented Feb 12, 2023 •

edited

Loading

cypress bot commented Feb 12, 2023 •

edited

Loading

warrensplayer left a comment

warrensplayer commented Feb 13, 2023

warrensplayer left a comment

warrensplayer left a comment •

edited

Loading

emilyrohrbough left a comment

podlesny-j commented Feb 15, 2023

fix: Fix type definitions for cy.reload() #25779

fix: Fix type definitions for cy.reload() #25779

Conversation

podlesny-j commented Feb 12, 2023 • edited Loading

Additional details

Steps to test

How has the user experience changed?

PR Tasks

CLAassistant commented Feb 12, 2023 • edited Loading

podlesny-j commented Feb 12, 2023 • edited Loading

cypress bot commented Feb 12, 2023 • edited Loading

40 flaky tests on run #44066 ↗︎

warrensplayer left a comment

Choose a reason for hiding this comment

warrensplayer commented Feb 13, 2023

warrensplayer left a comment

Choose a reason for hiding this comment

warrensplayer left a comment • edited Loading

Choose a reason for hiding this comment

emilyrohrbough left a comment

Choose a reason for hiding this comment

podlesny-j commented Feb 15, 2023

podlesny-j commented Feb 12, 2023 •

edited

Loading

CLAassistant commented Feb 12, 2023 •

edited

Loading

podlesny-j commented Feb 12, 2023 •

edited

Loading

cypress bot commented Feb 12, 2023 •

edited

Loading

warrensplayer left a comment •

edited

Loading